docs: consolidate documentation drift fixes from auditor backlog#1189
Merged
Conversation
Resolves the backlog of doc-freshness-check issues by applying the still-valid, code-verified fixes in one place:
- AGENTS.md/docs/ado-script.md: document all 11 ado-script bundles (gate, import, 9 exec-context-*); de-stale architecture tree and CLI index (mcp-author, trace, inspect, graph, whatif, lint, catalog, export-gate-schema).
- README.md: correct env field (accepted by parser, default {}), add ado-aw-debug field, update-pr update-description, exec-context bundle wording.
- docs/front-matter.md: full mcp-servers + execution-context contributor config (manual/pipeline/ci-push/workitem/schedule/repo/checks), ado-aw-debug section.
- docs/mcp.md: entrypoint-args wording, env scope (container vs HTTP).
- docs/safe-outputs.md: create-pull-request labels param.
- docs/schedule-syntax.md: parser aliases (weekday shorts, biweekly, unit aliases, bare utc).
- docs/execution-context.md: contributor internals.
- prompts/create-ado-agentic-workflow.md: model note, weekly, update-pr update-description.
Every change was verified against the source of truth (src/main.rs, src/compile/types.rs, src/fuzzy_schedule.rs, src/safeoutputs/, scripts/ado-script/package.json).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Consolidated Documentation Drift Fixes
The
doc-freshness-checkauditor accumulated 37 open issues because itcouldn't open PRs (a protected-files config bug, fixed in #1188). This PR
consolidates the still-valid, code-verified fixes from that backlog into a
single change, so the whole backlog can be closed.
Recurring duplicates (e.g. "duplicate
ir/tree", "undocumentedexec-context-pr-synth.js", "missing CLI commands") were de-duplicated, andeach remaining claim was verified against the source of truth before
applying. Issues whose drift was already fixed are closed as resolved by the
overlapping fixes here.
Files changed
AGENTS.mdexec-context-*); add 7 missingexec-context-*source dirs; update CLI index (mcp-author,trace,inspect,graph,whatif,lint,catalog,export-gate-schema); refresh execution-context blurbREADME.mdenvfield (accepted by parser, default{}); addado-aw-debugfield;update-prupdate-description; exec-context bundle wordingdocs/ado-script.mddocs/front-matter.mdmcp-serversexample + execution-context contributor config (manual/pipeline/ci-push/workitem/schedule/repo/checks);ado-aw-debugsectiondocs/mcp.mdentrypoint-argswording;envscope (container vs HTTP)docs/safe-outputs.mdcreate-pull-request.labelsagent paramdocs/schedule-syntax.mdbiweekly, unit aliases, bareutc)docs/execution-context.mdprompts/create-ado-agentic-workflow.mdweekly,update-pr update-descriptionVerification
Every claim was checked against code, not just the issue text:
src/main.rs(clapCommandsenum)src/compile/types.rs(ExecutionContextConfigand per-contributor structs;include-emaildefaultfalse,max-items5,max-body-kb32)src/fuzzy_schedule.rsscripts/ado-script/package.json(11build:*targets)update-properations →src/safeoutputs/update_pr.rs(VALID_OPERATIONSincludesupdate-description)Pure documentation change — no code, lock files, or workflows touched.
Closes #666
Closes #719
Closes #825
Closes #829
Closes #834
Closes #836
Closes #839
Closes #889
Closes #898
Closes #907
Closes #925
Closes #964
Closes #966
Closes #978
Closes #979
Closes #985
Closes #986
Closes #997
Closes #1029
Closes #1046
Closes #1052
Closes #1066
Closes #1068
Closes #1072
Closes #1084
Closes #1089
Closes #1106
Closes #1114
Closes #1121
Closes #1123
Closes #1126
Closes #1129
Closes #1143
Closes #1155
Closes #1175
Closes #1177
Closes #1180